home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / ozbii11d.arc / OZBEXT.DOC < prev    next >
Text File  |  1990-08-06  |  36KB  |  652 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                    OZBEXT II
  21.                                   Version 1.1b
  22.     An external protocol module for the CompuServe "B" and "BPlus" protocols
  23.  
  24.                              Copyright(c)1987,1990
  25.                                   Steve Sneed
  26.                               CIS ID# 70007,3574
  27.  
  28.  
  29. Welcome to OZBEXT!
  30. ------------------
  31.  
  32. OZBEXT II is an "external protocol module", a program that allows you to add
  33. the CompuServe "B" and "BPlus" file transfer protocols into other communi-
  34. cations programs.  While not designed primarily as such, the program can
  35. also be used as a (limited) stand-alone communications package for accessing
  36. the CompuServe Information Service (CIS).
  37.  
  38. Popular file transfer protocols such as XMODEM do not function well under
  39. CompuServe's complex packet-switching network.  The KERMIT protocol, while
  40. operational, is very slow on CIS.  CompuServe developed the B/B+ protocols
  41. to provide optimum performance on the network - it is the recomended method
  42. of file transfer when using CIS.
  43.  
  44. OZBEXT II works with all major commercial and shareware/freeware communications
  45. programs, and can be used with any comm program that can shell out to DOS
  46. without dropping the connection.  On those programs that provide the capa-
  47. bility, OZBEXT II works best when set up as an external protocol callable from
  48. within the program (examples are ProComm Plus, QModem, Boyan and GT-PowerComm.)
  49. A wide range of options, both on the command line and within the program, allow
  50. you to configure the program to match your needs.  The program automatically
  51. matches itself to your existing communications port configuration, meaning you
  52. do not have to worry about setting things like baud rate and parity when
  53. calling the program.
  54.  
  55. If you want or need the ability to view CompuServe's RLE and GIF graphics,
  56. such as the radar weather maps, CB pictures, stock trends analysis, and the
  57. over 6000 graphics images in the Graphics Forums, you will want to get OZBEXT
  58. II's sister program, OZRLE.  OZRLE provides all the capabilities of this
  59. program plus adds the ability to view, offline or online in realtime, the
  60. available graphics files and displays CIS provides.  In addition, OZRLE
  61. automatically captures images viewed online to a file for later offline
  62. viewing, saving you substantial connect-time charges.  OZRLE supports all major
  63. IBM video hardware types, including Hercules monochrome, CGA, EGA, MCGA, VGA,
  64. and many "Super" VGA cards.  If you need online graphics capability on BBS's
  65. and other services then BBSGIF will fit the bill; it provides all of the online
  66. graphics capabilities of OZRLE but uses the XMODEM-type protocols.
  67.  
  68.  
  69. Before we start...
  70. ------------------
  71.  
  72. Please read this documentation completely.  I know you want to get using the
  73. program right away, but taking a few minutes now may well save you time and
  74. money (in connect-time charges) later.  The program is very simple to use,
  75. and for most users' configurations is fully automatic, but an ounce of pre-
  76. vention is worth a pound of cure.  Thanks!
  77.  
  78. Users of previous versions please note: while much appears the same in this
  79. version, it is completely new; at a minimum please review the command line
  80. switch/environment variables section and the "For users of previous versions"
  81. sections before striking out with this new version.
  82.  
  83. It is assumed throughout this document that you have a good basic under-
  84. standing of DOS commands, batch files and batch file commands, what
  85. "environment variables" are and how to set them.  If this is not the case,
  86. please have a good MS-DOS tutorial book handy in case I use unfamiliar
  87. terminology.
  88.  
  89. Help for this program is available online in the IBMNew forum on CompuServe.
  90. Many program-specific help files written by SysOp Connie Kageyama are
  91. available in LIBrary 2 of that forum.  Do a "DIR *.HLP" at the "!" prompt
  92. in that library for a list of those files, or do a "BRO/KEY:HELP" at the
  93. same prompt.  The sysops themselves are available to answer questions, and
  94. of course I check the forums daily to help users.
  95.  
  96.  
  97.  
  98. The Legalities...
  99. -----------------
  100.  
  101. This program is the copyrighted work of its author, Steve Sneed.  All rights
  102. under US copyright law are reserved.  The author hereby grants to private,
  103. noncommercial users of this program a limited license to use, copy and
  104. distribute the program free of charge, as long as:
  105.  
  106. a) the program and its accompanying files are not modified in any way other
  107.    than changing the "archive format" used to store and transmit the program;
  108.  
  109. b) no charge is made for any distribution beyond a nominal disk/duplication
  110.    fee; and
  111.  
  112. c) the distribution of the program is not done by a business, company or
  113.    private entity whose primary business purpose is the distribution of
  114.    public domain and/or "shareware" software, by any means magnetic or
  115.    electronic, for profit.  Specific exclusion of this clause is hereby
  116.    granted by the author to The First Osborne Group (FOG) and The Public
  117.    (Software) Library.  This clause does not limit distribution by Bulletin
  118.    Board Systems or other information services, and a fee may be charged
  119.    for such access as long as such fees are not charged specifically for
  120.    this software.
  121.  
  122. If the program is used for commercial purposes, a license from the author
  123. is required along with payment of a $15 license fee per copy.  Multi-copy
  124. and site licenses are available; contact the author at the address listed
  125. at the end of this document for more information.  "Commercial purposes"
  126. as used above is defined as use by a company or government service or
  127. organization in an official capacity, or use by a company or individual
  128. whereby financial profit is made from such use - for example, a stock broker
  129. who uses the program to aquire ticker information for clients.  Specific
  130. exclusion of this clause is hereby granted by the author to CompuServe Inc.,
  131. Borland International, TurboPower Software, and PCMagNet.  No other rights
  132. are in any way relinqushed by the author, and the author reserves sole right
  133. to grant and administer licensing and distribution.
  134.  
  135. This software is provided "as-is", without warranty of any kind, including but
  136. not limited to any warranty of mercantibility or suitability for a specific
  137. purpose.  At no time will the author be held liable for any loss or damage,
  138. including loss of data or time, due to any operation or use of this program,
  139. even if the author has been informed of such loss or potential for loss.
  140.  
  141. "GIF", "GIF Format" and "Graphic Interchange Format" are Service Marks of
  142. CompuServe Inc., an H&R Block Company.
  143.  
  144.  
  145. Installing OZBEXT II
  146. --------------------
  147.  
  148. OZBEXT II generally should be installed in the same location as your comm
  149. program. If you use a hard disk, this means in the same subdirectory.  If you
  150. use more than one comm program with OZBEXT II and have different programs in
  151. different subdirectories, be sure to place OZBEXT II in a subdirectory that is
  152. on your DOS path.
  153.  
  154. OZBEXT II is delivered to the CompuServe forums in "ZIPped" format, using the
  155. PKZIP 1.10 utility by Phil Katz.  Some forums (and BBS systems, if that is
  156. where you aquired this program) may re-compile the program files into a
  157. different archive format such as the .ARC format, or may use a utility like
  158. LHARC to create a self-extracting program archive.  Once you have copied the
  159. archive file or self-extractor onto your disk, you will need to use the
  160. appropriate un-arc utility (if not a self-extractor) to un-arc the program
  161. files back to their original runable state. Utilities for this purpose are
  162. available in most forums on CompuServe, and on nearly every BBS in the world.
  163.  
  164.  
  165. Configuring OZBEXT II
  166. ---------------------
  167.  
  168. Configuration of OZBEXT II is very simple.  The program uses a "standard"
  169. internal configuration that will be correct for 90% or better of users.
  170. The program is quite flexible, however; almost any type of special con-
  171. figuration used on CIS is supported by the program, as well as several
  172. options governing the way the program functions or performs.
  173.  
  174. The following list contains OZBEXT II's nominal configuration.  Only if
  175. your particular configuration differs from this list should you worry
  176. about the various settings available.
  177.  
  178. * Uses the COM1: serial port/modem.
  179. * Uses the chosen port's existing baud rate, parity and data/stopbits settings.
  180. * Uses full-duplex communications.
  181. * Provides an audible alarm at the end of a protocol transfer.
  182. * Returns to its own internal terminal mode at the end of a transfer.
  183. * Uses the DOS current working directory for storage of downloaded files,
  184.   and looks in the same directory for files to upload.
  185. * On exit, leaves the modem CarrierDetect line high and restores the port to
  186.   the same configuration in which it was found.
  187. * Perform no logging of transfer success.
  188.  
  189.  
  190. Setting Options
  191. ---------------
  192.  
  193. If one or more of the above settings does not match your configuration, there
  194. are two possible ways to change things.  The first way is thru setting
  195. variables in the DOS environment.  The second is to use command line parameters
  196. when executing the program.  If you are calling OZBEXT II from a program such
  197. as QModem that wants to see a batch file rather than a free- standing program
  198. to execute, it is simpler to use the command line parameters within the batch
  199. file (saving the DOS environment space for other programs.) Parameters set via
  200. environment variables can be overridden via command line options.
  201.  
  202. Below is a list of OZBEXT II's environment variable names and the associated
  203. options:
  204. DSZPORT=?
  205.   or
  206. OZPORT=?         Replace ? with your commport number (1 - 4 for PC-compats,
  207.                                                       1 - 8 for MCA machines)
  208. OZPATH=?         Replace ? with the full path to use for up/downloaded files
  209.  
  210. When using command line parameters, all parameters must begin with either
  211. a dash (-) or a forward slash (/) character.  Parameters that require qual-
  212. ifying information (such as the port selection parameter) must have the
  213. information immediately after the option letter with no space.  At least
  214. one space must separate each parameter.  Below is the list of available
  215. parameter option letters:
  216.  
  217. C{portnumber}   Select the comport.  If you use COM2, this would be "/C2".
  218.                 The default is COM1.  Ports 1 thru 4 are available for PC-
  219.                 compatible machines, and ports 1 thru 8 are available on
  220.                 PS/2's and other MCA-buss machines.
  221.  
  222.  
  223.  
  224. If you are using the program as a stand-alone comm program rather than from
  225. within another comm program (and, generally, _only_ when you use it as such),
  226. 4 other parameters are available to configure the port.  They are:
  227.  
  228. B{baudrate}     Specifies the baud rate setting at which to open the port.
  229.                 Available baud rates are 300, 1200, 2400, 4800, 9600, 19200,
  230.                 38400 and 56000.  The default is to use whatever setting the
  231.                 port currently holds.
  232.  
  233. P{parity}       Specifies the parity setting to use.  Normally either None
  234.                 or Even, but Odd, Mark and Space settings are available as
  235.                 well.  You only have to provide the first letter of the
  236.                 parity type word (so setting None parity would be "/PN".)
  237.  
  238. W{dataword}     Specifies the data word length; 5, 6, 7 or 8 databits.
  239.  
  240. S{stopbits}     Specifies the number of stop bits (almost always 1.)
  241.  
  242.  
  243. The other available parameters are used to configure the way OZBEXT II works.
  244. They are:
  245.  
  246. X               Exit OZBEXT II immediately on completion of a protocol
  247.                 transfer. The default is to return to OZBEXT II's internal
  248.                 terminal mode so you can download more files or navigate to
  249.                 another area of CIS.  This option is normally only used when
  250.                 the program is being called from within another comm program's
  251.                 script file for automatic execution.
  252.  
  253. J               Log results of all transfers to OZBEXT.LOG.  The file is
  254.                 created if it does not exist.  The default is to not log
  255.                 xfers; this just allows those that want logging to have it.
  256.  
  257. D               Drop carrier on exit.  The default is to leave CarrierDetect
  258.                 high.  Using this parameter will mean that OZBEXT II will break
  259.                 any existing connection on the modem when exiting - not a good
  260.                 idea when you are loading the program from within another
  261.                 comm package.
  262.  
  263. N               Turn off the audible alarm normally provided at the end of a
  264.                 protocol transfer.  The default is to provide a beeper at
  265.                 the end of a proto transfer and wait for a keypress before
  266.                 continuing.  When this switch is used, no alarm sounds and
  267.                 the program does not wait for the keypress.  (Version 13.1cd
  268.                 note: this turns off *all* noise, including the system bell
  269.                 when a ^G is received.)
  270.  
  271. Q               Automatically send an XON character on startup.  This param
  272.                 is normally only used with the CIS-specific "auto-navigator"
  273.                 programs AUTOSIG and TAPCIS, both of which send an XOFF flow
  274.                 control command to CIS when shelling out to DOS.
  275.  
  276. U               Automatically send a Ctrl-U character on startup.  Using this
  277.                 parameter means that, on startup of OZBEXT II, the CIS system
  278.                 will automatically interrogate OZBEXT for its terminal-type
  279.                 and protocol-support capabilities.  This option should be
  280.                 used with caution; in a few places that you might call OZBEXT
  281.                 II the sending of the Ctrl-U may confuse the CIS system or may
  282.                 abort the imput prompt that was waiting when you called OZBEXT
  283.                 II. 
  284.  
  285.  
  286. L               Use a large (block) cursor while in the program.  This can be
  287.                 handy for those using the program on a laptop.  Laptop users
  288.                 will probably want to use the OZCOLS program to set the display
  289.                 colors to a reasonable set for their display type as well.
  290.  
  291. O               Turns off checking for the Carrier Detect signal from the
  292.                 modem during use.  Normally OZBEXT II checks for this signal
  293.                 during a protocol transfer and if the signal is lost (for
  294.                 example, when the phone line connection is broken due to
  295.                 line noise or other problem) the protocol transfer is
  296.                 automatically aborted.  Some CIS users are lucky enoough
  297.                 to be connected to the network via direct serial link; these
  298.                 links are usually a minimal 3-wire connection without CD
  299.                 support.  Users so configured should use this switch; do
  300.                 not use this switch if you connect to CIS via modem unless
  301.                 you experience problem initiating a transfer.
  302.  
  303. F{path}         Tells OZBEXT II to put all downloaded files in the {path}
  304.                 drive and/or subdirectory, and to take all uploaded files
  305.                 from that same location.  OZBEXT II verifies that the specified
  306.                 path does exist and if it does not notifies you of the error
  307.                 and reverts to the current DOS working directory.  Note that
  308.                 you can override this path by including any desired path with
  309.                 the filename when answering the "Filename for your computer:"
  310.                 prompt from CIS right before beginning the transfer.
  311.  
  312.  
  313. Running OZBEXT II
  314. -----------------
  315.  
  316. OZBEXT II is simple to use.  Depending on what general communications software
  317. you use, it can be made almost automatic.  Due to the wide range of different
  318. communications programs available, no one setup will always be right for
  319. your particular configuration.  However, following these guidelines will make
  320. using the program simple and straightforward.
  321.  
  322. 1)  If your comm program supports it, always install OZBEXT II as an external
  323.     protocol module.  Some programs or versions of programs do not support
  324.     defined external protocol modules but do allow the definition of external
  325.     programs (like editors.)  If this is true for your software, use that
  326.     type of setup.  Only use OZBEXT II from a "general" DOS shell if your soft-
  327.     ware provides no other support for external programs.  Installing OZBEXT II
  328.     as an external protocol module means calling OZBEXT II will be done in the
  329.     same manner as all other protocols, giving you a consistant interface.
  330.  
  331. 2)  If your program requires batch files for external protocol modules (ala
  332.     QModem and a few others), do all parameters options on the batch file
  333.     command line.  Here is an example batch file for QModem:
  334.  
  335.     ECHO OFF
  336.     CLS
  337.     OZBEXT /c2 /fA:\DNLD\TODAY
  338.     CLS
  339.  
  340.     This type of setup is also recommended if you use the program from a
  341.     "plain" DOS shell or from within AutoSIG or TAPCIS, or if you run the
  342.     program standalone.
  343.  
  344. 3)  If your communications program is like Boyan (where you can call the
  345.     program directly), it is better to use environment variables to set
  346.     any needed options.  This is best done in your AUTOEXEC.BAT file so
  347.     that the variables are always set.  Programs like Boyan make it easy
  348.     to set a single configuration but make it difficult to modify that
  349.     configuration for special cases; make your setup flexible.
  350.  
  351. 4)  In all the above cases, note that unlike most other protocol modules
  352.     OZBEXT II does not distingush between upload and download on the command
  353.     line.  This is handled at the start of a protocol transfer by the protocol
  354.     itself.  Therefore, you generally only need one configuration for both
  355.     the upload and download entries in your comm program.  However, a tip here
  356.     is that if you use different subdirectories for storing downloads and
  357.     finding uploads, you can set up separate configurations with different
  358.     paths on the /F option on the command line (either batch file or direct
  359.     command methods), or set an environment variable for the files path for
  360.     downloads and override it with a command line setting in the upload setup.
  361.  
  362.  
  363.  
  364. Using OZBEXT II
  365. ---------------
  366.  
  367. Most protocol modules, when executed, immediately enter the protocol itself.
  368. The B protocols do not work this way.  CIS sends a special interrogation
  369. sequence to the remote system (you) to make sure the remote can in fact do
  370. B and/or B+ before initiating the protocol itself.  OZBEXT II _must_ be loaded
  371. and running to reply to this interrogation properly, or you may well not be
  372. able to do the transfer.  (This is not a deficiency, it is a safety mechanism
  373. for both CIS and you.)  Many places on CIS where you can transfer files, this
  374. interrogation may not be done immediately prior to the protocol initiation;
  375. often it is done when you first request a transfer but before CIS has asked
  376. you for the filename to process and the file type (binary or ASCII.)  Because
  377. of this you should call OZBEXT II _before_ you request the transfer.  OZBEXT II
  378. comes up in terminal mode so that you can answer any pending prompts, etc.
  379.  
  380. Usually, when you shell out to OZBEXT II from another comm program, there is
  381. a prompt from CIS pending input.  There is no way OZBEXT II can know what this
  382. prompt was and therefore redisplay it (or anything else that was on the screen
  383. when you called it) so you must remember what the prompt was and reply to
  384. it after OZBEXT II is operational.  This is no problem; just type in what you
  385. would have had you been sitting at the prompt.  CIS never sees OZBEXT II load
  386. so it never knows you were not able to see the prompt.
  387.  
  388. Some users have noted that they "forget I'm in OZBEXT II rather than my main
  389. program."  OZBEXT II provides a status line at the bottom of the screen at all
  390. times to remind you.  I have tried to make sure it does not resemble too
  391. closely the status lines provided by many other comm programs, to make this
  392. recognition easier.   An added tip here is to use the OZCOLS utility program to
  393. set the colors used by OZBEXT II do some set different from your main program.
  394.  
  395. Many CIS users (most?) log in at 7 bits/Even parity.  OZBEXT II has no problem
  396. with this; it knows how to switch to 8 bits/No parity for the actual transfer
  397. and back at the correct times.  HOWEVER... some serial ports and/or modems
  398. do not handle the "flying switch" properly and will cause grief.  For this
  399. reason I recommend you use 8 bits/No parity at all times on CIS.  To do so
  400. you must change some of your "user profile" parameters that CIS maintains
  401. on you.  At any CIS "!" prompt, issue a GO TERMINAL command and follow the
  402. menus.
  403.  
  404.  
  405. Commands Within OZBEXT II
  406. -------------------------
  407.  
  408. OZBEXT II provides several commands while operational.  These all are used to
  409. modify the same functions you set with command line options or environment
  410. variables.  Generally, the letter used for a particular option setting in the
  411. list above will be the key used with the [Alt] key to modify that option while
  412. in OZBEXT II. To see a menu of available Alt-Key commands in the program, press
  413. the [Home] key.  One extra command is available, however: Alt-X is used to exit
  414. the program.
  415.  
  416.  
  417.  
  418. CIS Protocols
  419. -------------
  420.  
  421. There are three distinct species of B protocol supported by CIS: "Classic" B,
  422. "Quick" B and B Plus.  Most CIS users know that Classic B is the old (and slow)
  423. version of the protocol, but there seems to be a large amount of misconception
  424. concerning QuickB versus BPlus; many users assume that QuickB is faster than
  425. BPlus and therefore preferred (I guess because of the "Quick" in the name.)
  426. This is incorrect.  QuickB and BPlus use almost exactly the same core
  427. procedures to perform the transfer, and under nominal conditions the two will
  428. post identical or nearly identical transfer times.  What BPlus adds is
  429. flexability and safety, by adding features such as Aborted Transfer Resume and
  430. better file management including file information transfer at protocol start,
  431. and more flexible protocol packet size.  BPlus is always the preferred version
  432. to use.
  433.  
  434. Note that in many areas of CIS where a menu is displayed for protocol type,
  435. only the "B" and "QuickB" types are listed.  Both QuickB and BPlus are designed
  436. to negotiate the actual protocol type level during the protocol startup
  437. handshaking, but some early QuickB implementations (not this program) did not
  438. properly handshake the type - CIS accomodated these ill-behaved programs by
  439. making the QuickB option available in transfer menus.  However, when using this
  440. program, you should always respond with "B" at such a menu so that OZBEXT can
  441. properly handshake the negotiation with the host; selecting "QuickB" at such a
  442. menu forces QuickB mode from CIS and will cause problems when attempting to
  443. resume an aborted transfer as well as locking OZBEXT II into the 512-byte
  444. packet size (rather than the optimal 1024-byte size at 2400bps.)
  445.  
  446.  
  447. Protocol Performance
  448. --------------------
  449.  
  450. Another common misconception is that packet size has a large effect on protocol
  451. performance.  It does indeed effect performance, but not in the way most folks
  452. assume.  The difference in performance at 2400bps between 512-byte packets and
  453. 1024-byte packets is seldom more that 3% (unless network loading is heavy) *if*
  454. no transmission errors occur.  In the face of protocol errors where packets
  455. must be resent, smaller is often better because less time is wasted resending
  456. data.  The total size of the transfer, number of errors, network type and
  457. network loading factors cloud the issue, to the point that meaningful
  458. comparisons are quite difficult to achieve.  OZBEXT II juggles default packet
  459. size based on the current baud rate - 128 bytes for 300 baud, 512 bytes for
  460. 1200bps and 1024 bytes for 2400bps.  This strikes a reasonable balance between
  461. optimal thruput with no errors, and resend time in case of errors; each packet
  462. will take 4 to 5 seconds to send/receive at the current baud rate.  Some BPlus
  463. implementations lock the packet size at some value, usually 512 bytes.
  464. Sometimes this is for simplicity's sake, and sometimes because there are
  465. factors besides file transfer thruput to be considered (CompuServe's
  466. Information Manager is an example of the latter.)  OZBEXT II has been designed
  467. with one thought in mind: do everything it can to get the highest possible
  468. thruput during the file transfer.  It has proven to be consistently as fast or
  469. faster than any other program available that supports the QuickB and BPlus
  470. protocols, including CIS' own programs.
  471.  
  472.  
  473.  
  474. Users that are used to the transfer rates seen when connected to BBS systems
  475. are oftem shocked and disappointed at the transfer rates seen on CIS.  Keep in
  476. mind that, when connecting to a PC-based BBS, you are connecting to a system
  477. where the entire resources of the computer can typically be devoted to
  478. processing the protocol; such systems can on a clean connection turn optimal
  479. transfer rates for the baud rate used.  CIS is not a BBS; it is a group of
  480. several large computers sharing processor and system resources amomg dozens
  481. or even hundreds of users at any given time.  In order to allow access by all
  482. these people all over the world, CIS uses a special network of phone lines and
  483. satelite links called a "packet-switched" network.  The packet switcher is what
  484. makes all of this possible, but it also introduces delays in communications, so
  485. the typical transfer rate to/from CIS is often lower than a comparable transfer
  486. to/from a dedicated BBS.  The B series protocols have been designed with these
  487. delays in mind, so a QuickB or BPlus transfer should show a very close to
  488. optimal rate under light to moderate network loads.  When network loads are
  489. heavy (such as early weekday evenings, especially Mondays), performance can
  490. still drag down.  Also, connecting thru a supplimental carrier such as Tymnet
  491. can effect performance, as can connecting thru a busy node with several other
  492. users.  If you are concerned with the time you spend online to CIS and have
  493. large and/or many files to transfer, it behooves you to plan your session ahead
  494. of time, including running the session during off-peak times like the small
  495. hours of the morning or weekends.  Taking advantage of OZBEXT II's resumable
  496. transfers, by aborting the download and trying again at a different time or
  497. thru a different node when you see that network delays are seriously slowing
  498. the transfer, can also save you time and money.
  499.  
  500.  
  501.  
  502. The Protocol Window
  503. -------------------
  504.  
  505. During a protocol transfer a window appears on screen detailing the transfer
  506. activity.  Most things about the window are pretty self-explanitory, but one
  507. area deserves clarification - the "Port" and "Data" percentages on the "Ef/Tm"
  508. (Efficiency/Time) line.  The percentage displayed in the "Port" column is the
  509. comparison of current protocol "raw" port rate to the current port baud rate
  510. setting of the UART.  In other words, at 2400baud this figure would optimally
  511. be 100% if we were seeing 240 bytes per second comming in the port during a
  512. transfer.  Since CIS uses its packet-switching network and network delays of
  513. some magnitude are inevitable, this figure will almost always be less than
  514. 100%.  Normally you can expect greater than 230 cps "raw" rates on downloads,
  515. with uploads usually a bit more.  Connections established thru suplimental
  516. carriers such as Tymnet may well be less.  The percentage under the "Data"
  517. column, on the other hand, is the ratio of total data bytes received to the
  518. protocol's average "raw" port rate.  In other words, the efficiency of the
  519. actual data comming in the port.  This figure normally runs around 92 - 96%
  520. for binary files and 98 - 99% for ASCII text files.  However, bad packet
  521. resends when an error occurs and is corrected cause this figure to drop,
  522. sometimes dramatically.  Providing both figures makes it easier for you to
  523. decide when to abort a transfer.  If the "Port" figure is dramatically low
  524. (usually due to a high network traffic load but can also be due to delays
  525. caused by suplimental carrier networks), you may want to abort the transfer
  526. and wait until network traffic had dropped so good port rates are possible.
  527. If the "Data" figure is low (usually due to a high error-packet count), you
  528. may want to abort and call back on another node.  To avoid confusion, just
  529. remember that the "Port" efficiency percentage gives data on how efficient
  530. the port is operating, while the "Data" percentage gives overall port-to-data
  531. efficiency regardless of actual port rate or port efficiency.  The time display
  532. under the "File" column is the time the transfer has taken so far, while the
  533. time under the "Remaining" column is an estimate of the time it will take the
  534. rest of the transfer to complete.  The "Remaining" time figure will vary based
  535. on the current port rate, because it is recalculated at the end of each packet.
  536. Oh, one other thing: users with high-speed modems that run the port-to-modem
  537. link at 19.2Kbps or higher will see some really poor port eff. values.
  538. Remember that OZBEXT II uses the actual UART chip's baud rate setting to
  539. perform its calculations and cannot know to what speed the modem is throttled,
  540. so on a 19.2Kbps modem and 2400bps line you will see port rate of less than
  541. 20%.  The Data eff. rate will always be correct, since it is dependant on
  542. actual port thruput rather than hardware settings.
  543.  
  544.  
  545.  
  546. For users of previous versions...
  547. ---------------------------------
  548.  
  549. You may have noticed that this version is called "OZBEXT II".  This program
  550. is now going on 3 years old, and has seen about 12 versions released to the
  551. public.  It has matured from a somewhat flakey but servicable B-protocol only
  552. module in its original release to a solid program covering the full range of
  553. current-generation CompuServe-developed protocols, and from a single small
  554. file-transfer-only program to a whole family of programs supporting online
  555. graphics and other special features of CIS.  It has seen a steady stream of bug
  556. fixes and enhancements, and about once a year, it has received a complete,
  557. top-down rewrite.
  558.  
  559. This new one is that annual rewrite.  While it looks and acts very similar
  560. to every version since 10.1, it is in no way the same "under the hood."  The
  561. entire program is written using Object-Oriented Programming techniques, from
  562. the serial port library to the screen management to the protocol handler to
  563. the terminal emulation manager.  There are a total of 75 lines of programming
  564. source code kept from the last version, out of over 20,000 lines of code.
  565. Also, previous versions relied very heavily on routines from TurboPower
  566. Software's TurboProfessional and ObjectProfessional libraries' screen
  567. management services, and in the latter library's case were somewhat topheavy
  568. due to unneeded code being linked in; this version has a custom set of
  569. windowing object routines based on just the OPro low-level capabilities and
  570. optimized to its needs.
  571.  
  572. I set out to call this version "Version 20" (all development and early testing
  573. were done under that name), but realized that such a complete overhaul deserved
  574. a new name.  With literally thousands of users, a whole new name was out of the
  575. question (not to mention the possiblitiy of death threats from forum sysops!),
  576. yet it needed something to distingish it from earlier versions... so OZBEXT II
  577. was born.
  578.  
  579. Specifics: support for MCA commports above COM 2 is now fully automatic, so the
  580. /A and /I commandline and environment parameters are gone (if you are using a
  581. multiport card with ports at non-standard addresses or otherwise have oddball
  582. hardware, I will be happy to see what can be done in a custom version.)  The
  583. bug that caused problems with Abort Resume for those using the DOS utility
  584. SHARE with large partitions or on networks, and for DesqView users, has been
  585. removed.  DesqView awareness in the screen management has been improved.
  586. CarrierDetect checking throughout the program (especially at protocol startup)
  587. is dramatically improved, to eliminate the problems some users experienced with
  588. error messages from CIS and aborted transfer starts.  Port handshaking is
  589. faster and smoother, so users with high-speed modems that want to run the port
  590. at 19.2Kbps or 38.4Kbps can do so safely and reliably.  A couple of bugs in the
  591. detection and handling of 16550A-series UART chips have been squashed, and
  592. 16550A-series UARTs are now fully supported at the maximum 14-byte buffering
  593. level.  Users calling from overseas should find the program more robust in the
  594. face of intermittant PADs and phone systems.  Overall, the program is faster,
  595. smoother and more robust - and it is smaller than the last few versions.
  596.  
  597. One important note: the OZPAT utility program that could be used with previous
  598. versions to set the program's colors will not work with this new one.  A new
  599. program that replaces that utility, called OZCOLS, is available.
  600.  
  601.  
  602.  
  603. Kudos, Credits, Karma Enhancements
  604. ----------------------------------
  605.  
  606. The sysops of the IBMNet forums on CIS: Don Watkins, Connie Kageyama, Chris
  607. Dunford and Vern Buerg.  My primary beta testers, and the greatest group
  608. of folks around.  Ditto for Valerie Zen and Tom Potoki, sysops of the Graphics
  609. Forums on CIS, who also help test.
  610.  
  611. Kim, Brian, Rich and Terry (especially Terry) of TurboPower Software, for
  612. writing and maintaining the best libraries of Turbo Pascal utility routines in
  613. the free world.
  614.  
  615. Russ Ranshaw ("Wiz10") and others at CIS, for providing exellent documentation
  616. on the B+ protocols, and understandable source code for same.  Ditto to Brion
  617. Jones of CIS for informative literature on interrogation/response sequences
  618. and terminal reply codes.
  619.  
  620. Most importantly... you, the users.  Your questions, criticisms and sugges-
  621. tions have helped make the program what it is.  If you like it thank yourself,
  622. not me.
  623.  
  624.  
  625. Point of Contact
  626. ----------------
  627.  
  628. I can most easily be reached via CompuServe at ID# 70007,3574.  Please leave
  629. questions in either IBMNEW or IBMCOM rather than EasyPlex; other users or the
  630. sysops may well be able to give you a faster answer.  If you need to contact
  631. me concerning registration, please do so by EasyPlex or US mail:
  632.  
  633. Steve Sneed
  634. 409 San Juanico
  635. Santa Maria, CA.  93455
  636.  
  637. This program is not shareware in the traditional sense; I do not require
  638. private non-commercial users to register or pay a license fee (see the section
  639. on license requirements at the top of this document.)  If you have a burning
  640. urge to send me money anyway... I won't turn it down. <grin>  Please make
  641. checks payable to Steve Sneed.  Updates are only done thru CIS; I do not
  642. notify users of updates (except for fully-licensed commercial users.)  If
  643. you are registering for full license, please plainly state so in your
  644. corospondence along with how you are using the program.  Site licenses and
  645. multi-license discounts are available; please contact me for specific info.
  646. Finally, please do not call me voice, and I cannot accept any collect calls.
  647. Thanks.
  648.  
  649. I hope you enjoy the program!
  650.  
  651. <eof>
  652.